<!DOCTYPE html>
<html>
 <head>
  <meta charset="utf-8"/>
  <meta content="width=device-width, initial-scale=1.0" name="viewport"/>
  <meta content="width=device-width,initial-scale=1" name="viewport"/>
  <meta content="ie=edge" http-equiv="x-ua-compatible"/>
  <meta content="Copy to clipboard" name="lang:clipboard.copy"/>
  <meta content="Copied to clipboard" name="lang:clipboard.copied"/>
  <meta content="en" name="lang:search.language"/>
  <meta content="True" name="lang:search.pipeline.stopwords"/>
  <meta content="True" name="lang:search.pipeline.trimmer"/>
  <meta content="No matching documents" name="lang:search.result.none"/>
  <meta content="1 matching document" name="lang:search.result.one"/>
  <meta content="# matching documents" name="lang:search.result.other"/>
  <meta content="[\s\-]+" name="lang:search.tokenizer"/>
  <link crossorigin="" href="https://fonts.gstatic.com/" rel="preconnect"/>
  <link href="https://fonts.googleapis.com/css?family=Roboto+Mono:400,500,700|Roboto:300,400,400i,700&amp;display=fallback" rel="stylesheet"/>
  <style>
   body,
      input {
        font-family: "Roboto", "Helvetica Neue", Helvetica, Arial, sans-serif
      }

      code,
      kbd,
      pre {
        font-family: "Roboto Mono", "Courier New", Courier, monospace
      }
  </style>
  <link href="../../../_static/stylesheets/application.css" rel="stylesheet"/>
  <link href="../../../_static/stylesheets/application-palette.css" rel="stylesheet"/>
  <link href="../../../_static/stylesheets/application-fixes.css" rel="stylesheet"/>
  <link href="../../../_static/fonts/material-icons.css" rel="stylesheet"/>
  <meta content="84bd00" name="theme-color"/>
  <script src="../../../_static/javascripts/modernizr.js">
  </script>
  <title>
   Configuration — Torch-TensorRT v1.1.1 documentation
  </title>
  <link href="../../../_static/material.css" rel="stylesheet" type="text/css"/>
  <link href="../../../_static/pygments.css" rel="stylesheet" type="text/css"/>
  <link href="../../../_static/collapsible-lists/css/tree_view.css" rel="stylesheet" type="text/css"/>
  <script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js">
  </script>
  <script src="../../../_static/jquery.js">
  </script>
  <script src="../../../_static/underscore.js">
  </script>
  <script src="../../../_static/doctools.js">
  </script>
  <script src="../../../_static/language_data.js">
  </script>
  <script src="../../../_static/collapsible-lists/js/CollapsibleLists.compressed.js">
  </script>
  <script src="../../../_static/collapsible-lists/js/apply-collapsible-lists.js">
  </script>
  <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js">
  </script>
  <script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML">
  </script>
  <script type="text/x-mathjax-config">
   MathJax.Hub.Config({"tex2jax": {"inlineMath": [["$", "$"], ["\\(", "\\)"]], "processEscapes": true, "ignoreClass": "document", "processClass": "math|output_area"}})
  </script>
  <link href="../../../genindex.html" rel="index" title="Index"/>
  <link href="../../../search.html" rel="search" title="Search"/>
 </head>
 <body data-md-color-accent="light-green" data-md-color-primary="light-green" dir="ltr">
  <svg class="md-svg">
   <defs data-children-count="0">
    <svg height="448" id="__github" viewbox="0 0 416 448" width="416" xmlns="http://www.w3.org/2000/svg">
     <path d="M160 304q0 10-3.125 20.5t-10.75 19T128 352t-18.125-8.5-10.75-19T96 304t3.125-20.5 10.75-19T128 256t18.125 8.5 10.75 19T160 304zm160 0q0 10-3.125 20.5t-10.75 19T288 352t-18.125-8.5-10.75-19T256 304t3.125-20.5 10.75-19T288 256t18.125 8.5 10.75 19T320 304zm40 0q0-30-17.25-51T296 232q-10.25 0-48.75 5.25Q229.5 240 208 240t-39.25-2.75Q130.75 232 120 232q-29.5 0-46.75 21T56 304q0 22 8 38.375t20.25 25.75 30.5 15 35 7.375 37.25 1.75h42q20.5 0 37.25-1.75t35-7.375 30.5-15 20.25-25.75T360 304zm56-44q0 51.75-15.25 82.75-9.5 19.25-26.375 33.25t-35.25 21.5-42.5 11.875-42.875 5.5T212 416q-19.5 0-35.5-.75t-36.875-3.125-38.125-7.5-34.25-12.875T37 371.5t-21.5-28.75Q0 312 0 260q0-59.25 34-99-6.75-20.5-6.75-42.5 0-29 12.75-54.5 27 0 47.5 9.875t47.25 30.875Q171.5 96 212 96q37 0 70 8 26.25-20.5 46.75-30.25T376 64q12.75 25.5 12.75 54.5 0 21.75-6.75 42 34 40 34 99.5z" fill="currentColor">
     </path>
    </svg>
   </defs>
  </svg>
  <input class="md-toggle" data-md-toggle="drawer" id="__drawer" type="checkbox"/>
  <input class="md-toggle" data-md-toggle="search" id="__search" type="checkbox"/>
  <label class="md-overlay" data-md-component="overlay" for="__drawer">
  </label>
  <a class="md-skip" href="#src/pytorch-sphinx-theme/docs/configuring" tabindex="1">
   Skip to content
  </a>
  <header class="md-header" data-md-component="header">
   <nav class="md-header-nav md-grid">
    <div class="md-flex navheader">
     <div class="md-flex__cell md-flex__cell--shrink">
      <a class="md-header-nav__button md-logo" href="../../../index.html" title="Torch-TensorRT v1.1.1 documentation">
       <i class="md-icon">
        
       </i>
      </a>
     </div>
     <div class="md-flex__cell md-flex__cell--shrink">
      <label class="md-icon md-icon--menu md-header-nav__button" for="__drawer">
      </label>
     </div>
     <div class="md-flex__cell md-flex__cell--stretch">
      <div class="md-flex__ellipsis md-header-nav__title" data-md-component="title">
       <span class="md-header-nav__topic">
        Torch-TensorRT
       </span>
       <span class="md-header-nav__topic">
        Configuration
       </span>
      </div>
     </div>
     <div class="md-flex__cell md-flex__cell--shrink">
      <label class="md-icon md-icon--search md-header-nav__button" for="__search">
      </label>
      <div class="md-search" data-md-component="search" role="dialog">
       <label class="md-search__overlay" for="__search">
       </label>
       <div class="md-search__inner" role="search">
        <form action="../../../search.html" class="md-search__form" method="get" name="search">
         <input autocapitalize="off" autocomplete="off" class="md-search__input" data-md-component="query" data-md-state="active" name="q" placeholder="Search" spellcheck="false" type="text"/>
         <label class="md-icon md-search__icon" for="__search">
         </label>
         <button class="md-icon md-search__icon" data-md-component="reset" tabindex="-1" type="reset">
          
         </button>
        </form>
        <div class="md-search__output">
         <div class="md-search__scrollwrap" data-md-scrollfix="">
          <div class="md-search-result" data-md-component="result">
           <div class="md-search-result__meta">
            Type to start searching
           </div>
           <ol class="md-search-result__list">
           </ol>
          </div>
         </div>
        </div>
       </div>
      </div>
     </div>
     <div class="md-flex__cell md-flex__cell--shrink">
      <div class="md-header-nav__source">
       <a class="md-source" data-md-source="github" href="https://github.com/nvidia/Torch-TensorRT/" title="Go to repository">
        <div class="md-source__icon">
         <svg height="28" viewbox="0 0 24 24" width="28" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
          <use height="24" width="24" xlink:href="#__github">
          </use>
         </svg>
        </div>
        <div class="md-source__repository">
         Torch-TensorRT
        </div>
       </a>
      </div>
     </div>
     <div class="md-flex__cell md-flex__cell--shrink dropdown">
      <button class="dropdownbutton">
       Versions
      </button>
      <div class="dropdown-content md-hero">
       <a href="https://nvidia.github.io/Torch-TensorRT/" title="master">
        master
       </a>
       <a href="https://nvidia.github.io/Torch-TensorRT/v1.1.1/" title="v1.1.1">
        v1.1.1
       </a>
       <a href="https://nvidia.github.io/Torch-TensorRT/v1.1.0/" title="v1.1.0">
        v1.1.0
       </a>
       <a href="https://nvidia.github.io/Torch-TensorRT/v1.0.0/" title="v1.0.0">
        v1.0.0
       </a>
       <a href="https://nvidia.github.io/Torch-TensorRT/v0.4.1/" title="v0.4.1">
        v0.4.1
       </a>
       <a href="https://nvidia.github.io/Torch-TensorRT/v0.4.0/" title="v0.4.0">
        v0.4.0
       </a>
       <a href="https://nvidia.github.io/Torch-TensorRT/v0.3.0/" title="v0.3.0">
        v0.3.0
       </a>
       <a href="https://nvidia.github.io/Torch-TensorRT/v0.2.0/" title="v0.2.0">
        v0.2.0
       </a>
       <a href="https://nvidia.github.io/Torch-TensorRT/v0.1.0/" title="v0.1.0">
        v0.1.0
       </a>
       <a href="https://nvidia.github.io/Torch-TensorRT/v0.0.3/" title="v0.0.3">
        v0.0.3
       </a>
       <a href="https://nvidia.github.io/Torch-TensorRT/v0.0.2/" title="v0.0.2">
        v0.0.2
       </a>
       <a href="https://nvidia.github.io/Torch-TensorRT/v0.0.1/" title="v0.0.1">
        v0.0.1
       </a>
      </div>
     </div>
    </div>
   </nav>
  </header>
  <div class="md-container">
   <nav class="md-tabs" data-md-component="tabs">
    <div class="md-tabs__inner md-grid">
     <ul class="md-tabs__list">
      <li class="md-tabs__item">
       <a class="md-tabs__link" href="../../../index.html">
        Torch-TensorRT v1.1.1 documentation
       </a>
      </li>
     </ul>
    </div>
   </nav>
   <main class="md-main">
    <div class="md-main__inner md-grid" data-md-component="container">
     <div class="md-sidebar md-sidebar--primary" data-md-component="navigation">
      <div class="md-sidebar__scrollwrap">
       <div class="md-sidebar__inner">
        <nav class="md-nav md-nav--primary" data-md-level="0">
         <label class="md-nav__title md-nav__title--site" for="__drawer">
          <a class="md-nav__button md-logo" href="../../../index.html" title="Torch-TensorRT v1.1.1 documentation">
           <i class="md-icon">
            
           </i>
          </a>
          <a href="../../../index.html" title="Torch-TensorRT v1.1.1 documentation">
           Torch-TensorRT
          </a>
         </label>
         <div class="md-nav__source">
          <a class="md-source" data-md-source="github" href="https://github.com/nvidia/Torch-TensorRT/" title="Go to repository">
           <div class="md-source__icon">
            <svg height="28" viewbox="0 0 24 24" width="28" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
             <use height="24" width="24" xlink:href="#__github">
             </use>
            </svg>
           </div>
           <div class="md-source__repository">
            Torch-TensorRT
           </div>
          </a>
         </div>
         <ul class="md-nav__list">
          <li class="md-nav__item">
           <span class="md-nav__link caption">
            <span class="caption-text">
             Getting Started
            </span>
           </span>
          </li>
          <li class="md-nav__item">
           <a class="md-nav__link" href="../../../tutorials/installation.html">
            Installation
           </a>
          </li>
          <li class="md-nav__item">
           <a class="md-nav__link" href="../../../tutorials/getting_started_with_cpp_api.html">
            Getting Started with C++
           </a>
          </li>
          <li class="md-nav__item">
           <a class="md-nav__link" href="../../../tutorials/getting_started_with_python_api.html">
            Using Torch-TensorRT in Python
           </a>
          </li>
          <li class="md-nav__item">
           <a class="md-nav__link" href="../../../tutorials/creating_torchscript_module_in_python.html">
            Creating a TorchScript Module
           </a>
          </li>
          <li class="md-nav__item">
           <a class="md-nav__link" href="../../../tutorials/creating_torchscript_module_in_python.html#working-with-torchscript-in-python">
            Working with TorchScript in Python
           </a>
          </li>
          <li class="md-nav__item">
           <a class="md-nav__link" href="../../../tutorials/creating_torchscript_module_in_python.html#saving-torchscript-module-to-disk">
            Saving TorchScript Module to Disk
           </a>
          </li>
          <li class="md-nav__item">
           <a class="md-nav__link" href="../../../tutorials/ptq.html">
            Post Training Quantization (PTQ)
           </a>
          </li>
          <li class="md-nav__item">
           <a class="md-nav__link" href="../../../tutorials/torchtrtc.html">
            torchtrtc
           </a>
          </li>
          <li class="md-nav__item">
           <a class="md-nav__link" href="../../../tutorials/use_from_pytorch.html">
            Using Torch-TensorRT Directly From PyTorch
           </a>
          </li>
          <li class="md-nav__item">
           <a class="md-nav__link" href="../../../tutorials/runtime.html">
            Deploying Torch-TensorRT Programs
           </a>
          </li>
          <li class="md-nav__item">
           <a class="md-nav__link" href="../../../tutorials/using_dla.html">
            DLA
           </a>
          </li>
          <li class="md-nav__item">
           <span class="md-nav__link caption">
            <span class="caption-text">
             Notebooks
            </span>
           </span>
          </li>
          <li class="md-nav__item">
           <a class="md-nav__link" href="../../../_notebooks/CitriNet-example.html">
            Torch-TensorRT Getting Started - CitriNet
           </a>
          </li>
          <li class="md-nav__item">
           <a class="md-nav__link" href="../../../_notebooks/dynamic-shapes.html">
            Torch-TensorRT - Using Dynamic Shapes
           </a>
          </li>
          <li class="md-nav__item">
           <a class="md-nav__link" href="../../../_notebooks/EfficientNet-example.html">
            Torch-TensorRT Getting Started - EfficientNet-B0
           </a>
          </li>
          <li class="md-nav__item">
           <a class="md-nav__link" href="../../../_notebooks/Hugging-Face-BERT.html">
            Masked Language Modeling (MLM) with Hugging Face BERT Transformer
           </a>
          </li>
          <li class="md-nav__item">
           <a class="md-nav__link" href="../../../_notebooks/lenet-getting-started.html">
            Torch-TensorRT Getting Started - LeNet
           </a>
          </li>
          <li class="md-nav__item">
           <a class="md-nav__link" href="../../../_notebooks/Resnet50-example.html">
            Torch-TensorRT Getting Started - ResNet 50
           </a>
          </li>
          <li class="md-nav__item">
           <a class="md-nav__link" href="../../../_notebooks/ssd-object-detection-demo.html">
            Object Detection with Torch-TensorRT (SSD)
           </a>
          </li>
          <li class="md-nav__item">
           <a class="md-nav__link" href="../../../_notebooks/vgg-qat.html">
            Deploying Quantization Aware Trained models in INT8 using Torch-TensorRT
           </a>
          </li>
          <li class="md-nav__item">
           <span class="md-nav__link caption">
            <span class="caption-text">
             Python API Documenation
            </span>
           </span>
          </li>
          <li class="md-nav__item">
           <a class="md-nav__link" href="../../../py_api/torch_tensorrt.html">
            torch_tensorrt
           </a>
          </li>
          <li class="md-nav__item">
           <a class="md-nav__link" href="../../../py_api/logging.html">
            torch_tensorrt.logging
           </a>
          </li>
          <li class="md-nav__item">
           <a class="md-nav__link" href="../../../py_api/ptq.html">
            torch_tensorrt.ptq
           </a>
          </li>
          <li class="md-nav__item">
           <a class="md-nav__link" href="../../../py_api/ts.html">
            torch_tensorrt.ts
           </a>
          </li>
          <li class="md-nav__item">
           <span class="md-nav__link caption">
            <span class="caption-text">
             C++ API Documenation
            </span>
           </span>
          </li>
          <li class="md-nav__item">
           <a class="md-nav__link" href="../../../_cpp_api/torch_tensort_cpp.html">
            Torch-TensorRT C++ API
           </a>
          </li>
          <li class="md-nav__item">
           <a class="md-nav__link" href="../../../_cpp_api/namespace_torch_tensorrt.html">
            Namespace torch_tensorrt
           </a>
          </li>
          <li class="md-nav__item">
           <a class="md-nav__link" href="../../../_cpp_api/namespace_torch_tensorrt__logging.html">
            Namespace torch_tensorrt::logging
           </a>
          </li>
          <li class="md-nav__item">
           <a class="md-nav__link" href="../../../_cpp_api/namespace_torch_tensorrt__torchscript.html">
            Namespace torch_tensorrt::torchscript
           </a>
          </li>
          <li class="md-nav__item">
           <a class="md-nav__link" href="../../../_cpp_api/namespace_torch_tensorrt__ptq.html">
            Namespace torch_tensorrt::ptq
           </a>
          </li>
          <li class="md-nav__item">
           <span class="md-nav__link caption">
            <span class="caption-text">
             Contributor Documentation
            </span>
           </span>
          </li>
          <li class="md-nav__item">
           <a class="md-nav__link" href="../../../contributors/system_overview.html">
            System Overview
           </a>
          </li>
          <li class="md-nav__item">
           <a class="md-nav__link" href="../../../contributors/writing_converters.html">
            Writing Converters
           </a>
          </li>
          <li class="md-nav__item">
           <a class="md-nav__link" href="../../../contributors/useful_links.html">
            Useful Links for Torch-TensorRT Development
           </a>
          </li>
          <li class="md-nav__item">
           <span class="md-nav__link caption">
            <span class="caption-text">
             Indices
            </span>
           </span>
          </li>
          <li class="md-nav__item">
           <a class="md-nav__link" href="../../../indices/supported_ops.html">
            Operators Supported
           </a>
          </li>
         </ul>
        </nav>
       </div>
      </div>
     </div>
     <div class="md-sidebar md-sidebar--secondary" data-md-component="toc">
      <div class="md-sidebar__scrollwrap">
       <div class="md-sidebar__inner">
        <nav class="md-nav md-nav--secondary">
         <label class="md-nav__title" for="__toc">
          Contents
         </label>
         <ul class="md-nav__list" data-md-scrollfix="">
          <li class="md-nav__item">
           <a class="md-nav__link" href="#src-pytorch-sphinx-theme-docs-configuring--page-root">
            Configuration
           </a>
           <nav class="md-nav">
            <ul class="md-nav__list">
             <li class="md-nav__item">
              <a class="md-nav__link" href="#project-wide-configuration">
               Project-wide Configuration
              </a>
              <nav class="md-nav">
               <ul class="md-nav__list">
                <li class="md-nav__item">
                 <a class="md-nav__link" href="#html-theme-options">
                  HTML Theme Options
                 </a>
                 <nav class="md-nav">
                  <ul class="md-nav__list">
                   <li class="md-nav__item">
                    <a class="md-nav__link" href="#base-options">
                     Base options
                    </a>
                   </li>
                   <li class="md-nav__item">
                    <a class="md-nav__link" href="#toc-options">
                     TOC Options
                    </a>
                   </li>
                  </ul>
                 </nav>
                </li>
                <li class="md-nav__item">
                 <a class="md-nav__link" href="#html-context-options">
                  HTML Context Options
                 </a>
                </li>
               </ul>
              </nav>
             </li>
             <li class="md-nav__item">
              <a class="md-nav__link" href="#page-level-configuration">
               Page-level Configuration
              </a>
             </li>
             <li class="md-nav__item">
              <a class="md-nav__link" href="#how-the-table-of-contents-builds">
               How the Table of Contents builds
              </a>
             </li>
            </ul>
           </nav>
          </li>
          <li class="md-nav__item">
           <a class="md-nav__extra_link" href="../../../_sources/src/pytorch-sphinx-theme/docs/configuring.rst.txt">
            Show Source
           </a>
          </li>
          <li class="md-nav__item" id="searchbox">
          </li>
         </ul>
        </nav>
       </div>
      </div>
     </div>
     <div class="md-content">
      <article class="md-content__inner md-typeset" role="main">
       <h1 id="src-pytorch-sphinx-theme-docs-configuring--page-root">
        Configuration
        <a class="headerlink" href="#src-pytorch-sphinx-theme-docs-configuring--page-root" title="Permalink to this headline">
         ¶
        </a>
       </h1>
       <p>
        You can configure different parts of the theme.
       </p>
       <h2 id="project-wide-configuration">
        Project-wide Configuration
        <a class="headerlink" href="#project-wide-configuration" title="Permalink to this headline">
         ¶
        </a>
       </h2>
       <h3 id="html-theme-options">
        HTML Theme Options
        <a class="headerlink" href="#html-theme-options" title="Permalink to this headline">
         ¶
        </a>
       </h3>
       <p>
        The theme’s project-wide options are defined in the
        <code class="docutils literal notranslate">
         <span class="pre">
          pytorch_sphinx_theme/theme.conf
         </span>
        </code>
        file of this repository, and can be defined in your project’s
        <code class="docutils literal notranslate">
         <span class="pre">
          conf.py
         </span>
        </code>
        via
        <code class="docutils literal notranslate">
         <span class="pre">
          html_theme_options
         </span>
        </code>
        . For example:
       </p>
       <div class="highlight-python notranslate">
        <div class="highlight">
         <pre><span></span><span class="n">html_theme_options</span> <span class="o">=</span> <span class="p">{</span>
    <span class="s1">'canonical_url'</span><span class="p">:</span> <span class="s1">''</span><span class="p">,</span>
    <span class="s1">'analytics_id'</span><span class="p">:</span> <span class="s1">''</span><span class="p">,</span>
    <span class="s1">'logo_only'</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
    <span class="s1">'display_version'</span><span class="p">:</span> <span class="kc">True</span><span class="p">,</span>
    <span class="s1">'prev_next_buttons_location'</span><span class="p">:</span> <span class="s1">'bottom'</span><span class="p">,</span>
    <span class="s1">'style_external_links'</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
    <span class="s1">'vcs_pageview_mode'</span><span class="p">:</span> <span class="s1">''</span><span class="p">,</span>
    <span class="c1"># Toc options</span>
    <span class="s1">'collapse_navigation'</span><span class="p">:</span> <span class="kc">True</span><span class="p">,</span>
    <span class="s1">'sticky_navigation'</span><span class="p">:</span> <span class="kc">True</span><span class="p">,</span>
    <span class="s1">'navigation_depth'</span><span class="p">:</span> <span class="mi">4</span><span class="p">,</span>
    <span class="s1">'includehidden'</span><span class="p">:</span> <span class="kc">True</span><span class="p">,</span>
    <span class="s1">'titles_only'</span><span class="p">:</span> <span class="kc">False</span>
<span class="p">}</span>
</pre>
        </div>
       </div>
       <p>
        The following options are available:
       </p>
       <h4 id="base-options">
        Base options
        <a class="headerlink" href="#base-options" title="Permalink to this headline">
         ¶
        </a>
       </h4>
       <ul class="simple">
        <li>
         <p>
          <code class="docutils literal notranslate">
           <span class="pre">
            canonical_url
           </span>
          </code>
          String. This will specify a
          <a class="reference external" href="https://en.wikipedia.org/wiki/Canonical_link_element">
           canonical url
          </a>
          to let search engines know they should give higher ranking to latest version of the docs.
The url points to the root of the documentation and requires a trailing slash.
         </p>
        </li>
        <li>
         <p>
          <code class="docutils literal notranslate">
           <span class="pre">
            analytics_id
           </span>
          </code>
          String. Change the Google Analytics ID that is included on pages.
         </p>
        </li>
        <li>
         <p>
          <code class="docutils literal notranslate">
           <span class="pre">
            display_version
           </span>
          </code>
          Bool. With this disabled, the version number isn’t shown at the top of the sidebar.
         </p>
        </li>
        <li>
         <p>
          <code class="docutils literal notranslate">
           <span class="pre">
            prev_next_buttons_location
           </span>
          </code>
          String. can take the value
          <code class="docutils literal notranslate">
           <span class="pre">
            bottom
           </span>
          </code>
          ,
          <code class="docutils literal notranslate">
           <span class="pre">
            top
           </span>
          </code>
          ,
          <code class="docutils literal notranslate">
           <span class="pre">
            both
           </span>
          </code>
          , or
          <code class="docutils literal notranslate">
           <span class="pre">
            None
           </span>
          </code>
          and will display the “Next” and “Previous” buttons accordingly.
         </p>
        </li>
        <li>
         <p>
          <code class="docutils literal notranslate">
           <span class="pre">
            style_external_links
           </span>
          </code>
          Bool. Add an icon next to external links. Defaults to
          <code class="docutils literal notranslate">
           <span class="pre">
            False
           </span>
          </code>
          .
         </p>
        </li>
        <li>
         <p>
          <code class="docutils literal notranslate">
           <span class="pre">
            vcs_pageview_mode
           </span>
          </code>
          String. Changes how to view files when using
          <cite>
           display_github
          </cite>
          ,
          <cite>
           display_gitlab
          </cite>
          , etc.
When using Github or Gitlab this can be:
          <cite>
           blob
          </cite>
          (default),
          <cite>
           edit
          </cite>
          , or
          <cite>
           raw
          </cite>
          ,
on Bitbucket, this can be either:
          <cite>
           view
          </cite>
          (default) or
          <cite>
           edit
          </cite>
          .
         </p>
        </li>
       </ul>
       <h4 id="toc-options">
        TOC Options
        <a class="headerlink" href="#toc-options" title="Permalink to this headline">
         ¶
        </a>
       </h4>
       <p>
        These effect how we display the Table of Contents in the side bar. You can read more about them here:
        <a class="reference external" href="http://www.sphinx-doc.org/en/stable/templating.html#toctree">
         http://www.sphinx-doc.org/en/stable/templating.html#toctree
        </a>
       </p>
       <ul class="simple">
        <li>
         <p>
          <code class="docutils literal notranslate">
           <span class="pre">
            collapse_navigation
           </span>
          </code>
          Bool. With this enabled, you will lose the
          <code class="docutils literal notranslate">
           <span class="pre">
            [+]
           </span>
          </code>
          drop downs next to each section in the sidebar.
         </p>
        </li>
        <li>
         <p>
          <code class="docutils literal notranslate">
           <span class="pre">
            sticky_navigation
           </span>
          </code>
          Bool. This causes the sidebar to scroll with the main page content as you scroll the page.
         </p>
        </li>
        <li>
         <p>
          <code class="docutils literal notranslate">
           <span class="pre">
            navigation_depth
           </span>
          </code>
          Int. Indicate the max depth of the tree; by default, 4 levels are included;
set it to -1 to allow unlimited depth.
         </p>
        </li>
        <li>
         <p>
          <code class="docutils literal notranslate">
           <span class="pre">
            includehidden
           </span>
          </code>
          Bool. Specifies if the sidebar includes toctrees marked with the
          <code class="docutils literal notranslate">
           <span class="pre">
            :hidden:
           </span>
          </code>
          option
         </p>
        </li>
        <li>
         <p>
          <code class="docutils literal notranslate">
           <span class="pre">
            titles_only
           </span>
          </code>
          Bool. If True, removes headers within a page from the sidebar.
         </p>
        </li>
       </ul>
       <div class="admonition note">
        <p class="admonition-title">
         Note
        </p>
        <p>
         Setting
         <code class="docutils literal notranslate">
          <span class="pre">
           collapse_navigation
          </span>
         </code>
         to False and using a high
         <code class="docutils literal notranslate">
          <span class="pre">
           navigation_depth
          </span>
         </code>
         can cause projects with many files and a deep file structure to generate HTML files
that are significantly larger in file size and much longer compilation times.
        </p>
       </div>
       <h3 id="html-context-options">
        HTML Context Options
        <a class="headerlink" href="#html-context-options" title="Permalink to this headline">
         ¶
        </a>
       </h3>
       <p>
        TODO.
       </p>
       <h2 id="page-level-configuration">
        Page-level Configuration
        <a class="headerlink" href="#page-level-configuration" title="Permalink to this headline">
         ¶
        </a>
       </h2>
       <p>
        Pages support metadata that changes how the theme renders.
You can currently add the following:
       </p>
       <ul class="simple">
        <li>
         <p>
          <code class="docutils literal notranslate">
           <span class="pre">
            :github_url:
           </span>
          </code>
          This will force the “Edit on GitHub” to the configured URL
         </p>
        </li>
        <li>
         <p>
          <code class="docutils literal notranslate">
           <span class="pre">
            :bitbucket_url:
           </span>
          </code>
          This will force the “Edit on Bitbucket” to the configured URL
         </p>
        </li>
        <li>
         <p>
          <code class="docutils literal notranslate">
           <span class="pre">
            :gitlab_url:
           </span>
          </code>
          This will force the “Edit on GitLab” to the configured URL
         </p>
        </li>
       </ul>
       <h2 id="how-the-table-of-contents-builds">
        How the Table of Contents builds
        <a class="headerlink" href="#how-the-table-of-contents-builds" title="Permalink to this headline">
         ¶
        </a>
       </h2>
       <p>
        Currently the left menu will build based upon any
        <code class="docutils literal notranslate">
         <span class="pre">
          toctree(s)
         </span>
        </code>
        defined in your
        <code class="docutils literal notranslate">
         <span class="pre">
          index.rst
         </span>
        </code>
        file.
It outputs 2 levels of depth, which should give your visitors a high level of access to your
docs. If no toctrees are set the theme reverts to sphinx’s usual local toctree.
       </p>
       <p>
        It’s important to note that if you don’t follow the same styling for your rST headers across
your documents, the toctree will misbuild, and the resulting menu might not show the correct
depth when it renders.
       </p>
       <p>
        Also note that by default the table of contents is set with
        <code class="docutils literal notranslate">
         <span class="pre">
          includehidden=True
         </span>
        </code>
        . This allows you
to set a hidden toc in your index file with the
        <a class="reference external" href="http://sphinx-doc.org/markup/toctree.html">
         :hidden:
        </a>
        property that will allow you
to build a toc without it rendering in your index.
       </p>
       <p>
        By default, the navigation will “stick” to the screen as you scroll. However if your toc
is vertically too large, it will revert to static positioning. To disable the sticky nav
altogether change the setting in
        <code class="docutils literal notranslate">
         <span class="pre">
          conf.py
         </span>
        </code>
        .
       </p>
      </article>
     </div>
    </div>
   </main>
  </div>
  <footer class="md-footer">
   <div class="md-footer-nav">
    <nav class="md-footer-nav__inner md-grid">
    </nav>
   </div>
   <div class="md-footer-meta md-typeset">
    <div class="md-footer-meta__inner md-grid">
     <div class="md-footer-copyright">
      <div class="md-footer-copyright__highlight">
       © Copyright 2021, NVIDIA Corporation.
      </div>
      Created using
      <a href="http://www.sphinx-doc.org/">
       Sphinx
      </a>
      3.1.2.
             and
      <a href="https://github.com/bashtage/sphinx-material/">
       Material for
              Sphinx
      </a>
     </div>
    </div>
   </div>
  </footer>
  <script src="../../../_static/javascripts/application.js">
  </script>
  <script>
   app.initialize({version: "1.0.4", url: {base: ".."}})
  </script>
 </body>
</html>